home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 49 / Amiga Format CD49 (2000-01-17)(Future Publishing)(GB)(Track 1 of 3)[!][issue 2000-02].iso / -screenplay- / otherstuff / f1gplib_dev / autodocs / f1gp.doc next >
Text File  |  1999-12-06  |  6KB  |  195 lines
  1. TABLE OF CONTENTS
  2.  
  3. f1gp.library/f1gpAllocQuitNotify
  4. f1gp.library/f1gpCalcChecksum
  5. f1gp.library/f1gpDetect
  6. f1gp.library/f1gpFreeQuitNotify
  7. f1gp.library/f1gpGetDisplayInfo
  8. f1gp.library/f1gpRequestNotification
  9. f1gp.library/f1gpStopNotification
  10. f1gp.library/f1gpAllocQuitNotify             f1gp.library/f1gpAllocQuitNotify
  11.  
  12.    NAME
  13.     f1gpAllocQuitNotify -- ask to be notified when F1GP quits.
  14.  
  15.    SYNOPSIS
  16.     handle = f1gpAllocQuitNotify( task, signal )
  17.     D0                            A0    D0
  18.  
  19.     APTR f1gpAllocQuitNotify( struct Task *, ULONG );
  20.  
  21.    NOTES
  22.     This function is obsolete, please use f1gpRequestNotification()
  23.     instead.
  24.  
  25.    SEE ALSO
  26.     f1gpRequestNotification()
  27.  
  28. f1gp.library/f1gpCalcChecksum                   f1gp.library/f1gpCalcChecksum
  29.  
  30.    NAME
  31.     f1gpCalcChecksum -- Compute a standard F1GP file checksum. (V35)
  32.  
  33.    SYNOPSIS
  34.     checksum = f1gpCalcChecksum( data, datasize )
  35.     D0                           A0    D0
  36.  
  37.     ULONG f1gpCalcChecksum( UBYTE *, ULONG );
  38.  
  39.    FUNCTION
  40.     If you intend to alter any of F1GP's files (eg track files), you
  41.     will need to rewrite the 4 byte checksum also (last 4 bytes of file).
  42.     This function calculates the correct checksum from the given input
  43.     data and returns it as a ULONG.
  44.     
  45.    INPUTS
  46.     data     - a pointer to the array of bytes which you intend to save.
  47.     datasize - the size of the data array (in bytes), NOT including the
  48.                    checksum space (4 bytes).
  49.  
  50.    RESULTS
  51.     checksum - the 4 byte checksum that is usually located at the end
  52.            of F1GP's files (ie the last 4 bytes).
  53.  
  54. f1gp.library/f1gpDetect                               f1gp.library/f1gpDetect
  55.  
  56.    NAME
  57.     f1gpDetect -- Inquire whether F1GP is running in memory.
  58.  
  59.    SYNOPSIS
  60.     type = f1gpDetect();
  61.     D0
  62.  
  63.     LONG f1gpDetect( void );
  64.  
  65.    FUNCTION
  66.     This function scans the Exec task lists to determine whether F1GP
  67.     is currently running in memory.  If F1GP is resident then the type
  68.     is returned and HunkStart, Seg1, Seg3 in the F1GPBase structure
  69.     will be updated.  The type is also stored in the F1GPType field
  70.     in the F1GPBase structure.
  71.  
  72.     Each time this function is called the priority of F1GP is set to
  73.     -100, to stop it hogging processor time.
  74.  
  75.     Importantly, this function also automatically applies a number of
  76.     patches to F1GP which fix bugs and provide enhancements.
  77.  
  78.    RESULTS
  79.     type -    if F1GP was detected in memory, this will be indicate
  80.         what version of F1GP it is.  This will be one of
  81.         F1GPTYPE_STANDARD, F1GPTYPE_WC or F1GPTYPE_A600WWW.
  82.         If not detected, the value will be 0.
  83.  
  84. f1gp.library/f1gpFreeQuitNotify               f1gp.library/f1gpFreeQuitNotify
  85.  
  86.    NAME
  87.     f1gpFreeQuitNotify -- Free memory after f1gpAllocQuitNotify().
  88.  
  89.    SYNOPSIS
  90.     f1gpFreeQuitNotify( handle )
  91.                         A0
  92.  
  93.     void f1gpFreeQuitNotify( APTR );
  94.  
  95.    NOTES
  96.     This function is obsolete, please use f1gpStopNotification()
  97.     instead.
  98.  
  99.    SEE ALSO
  100.     f1gpStopNotification()
  101.  
  102. f1gp.library/f1gpGetDisplayInfo               f1gp.library/f1gpGetDisplayInfo
  103.  
  104.    NAME
  105.     f1gpGetDisplayInfo -- Obtain information about the F1GP display
  106.  
  107.    SYNOPSIS
  108.     dispinfo = f1gpGetDisplayInfo()
  109.     D0
  110.  
  111.     struct F1GPDisplayInfo *f1gpGetDisplayInfo( void );
  112.  
  113.    FUNCTION
  114.     Returns a pointer to a structure containing low-level information
  115.     on the current F1GP display.  Under no circumstances should you
  116.     modify this data (it is read only).  The sole intention of this
  117.     function is to allow the GPPatch patch in F1GP-Ed to work
  118.     correctly, when the AGA faster fetchmode and/or hardware scan
  119.     doubling patches are enabled.  Therefore, it is unlikely that you
  120.     will need to use this function.
  121.  
  122.    SEE ALSO
  123.  
  124. f1gp.library/f1gpRequestNotification     f1gp.library/f1gpRequestNotification
  125.  
  126.    NAME
  127.     f1gpRequestNotification -- ask to be notified when selected
  128.                                    F1GP events occur. (V36)
  129.  
  130.    SYNOPSIS
  131.     handle = f1gpRequestNotification( msgport, events )
  132.     D0                                A0       D0
  133.  
  134.     APTR f1gpRequestNotification( struct MsgPort *, ULONG )
  135.  
  136.    FUNCTION
  137.     This function allows a task to be notified instantly when certain
  138.     events occur in F1GP.  Multiple events can be requested by ORing
  139.     the event flags together.
  140.  
  141.     When a requested event occurs, a F1GPMessage will be sent to the
  142.     message port where you should process it and ReplyMsg() it.
  143.  
  144.     This call MUST be matched with a call to f1gpStopNotification(),
  145.     typically just before the calling task exits.
  146.  
  147.    INPUTS
  148.     msgport - pointer to a fully initialized message port, belonging to
  149.               the calling task
  150.  
  151.     events  - F1GPEVENT_QUITGAME - be notified when F1GP is exited by
  152.               the user (useful to allow your program to remove patches,
  153.               exit, etc, when F1GP quits)
  154.  
  155.           F1GPEVENT_EXITCOCKPIT - be notified when the user exits
  156.               the cockpit (e.g. presses Esc or at the end of a session)
  157.           and the F1GP menu system returns.  Can be useful if your
  158.               program needs to update anything when multitasking is
  159.               re-enabled by F1GP.
  160.  
  161.    RESULTS
  162.     handle - a pointer to an internal node structure if successful,
  163.          otherwise NULL.
  164.  
  165.    SEE ALSO
  166.     f1gpStopNotification()
  167.  
  168. f1gp.library/f1gpStopNotification           f1gp.library/f1gpStopNotification
  169.  
  170.    NAME
  171.     f1gpStopNotification -- Free all notification requests made by
  172.                                 f1gpRequestNotification(). (V36)
  173.  
  174.    SYNOPSIS
  175.     f1gpStopNotification( handle )
  176.                           A0
  177.  
  178.     void f1gpStopNotification( APTR );
  179.  
  180.    FUNCTION
  181.     Frees memory and resources allocated by a call to
  182.         f1gpRequestNotification(), which also means the calling task will
  183.     no longer be notified of any F1GP events.  The pointer passed in
  184.     MUST have been obtained by f1gpRequestNotification().
  185.  
  186.     If NULL is passed in, this function does nothing.
  187.  
  188.    INPUTS
  189.     handle - pointer returned from f1gpRequestNotification() or NULL.
  190.  
  191.    SEE ALSO
  192.     f1gpRequestNotification()
  193.  
  194.  
  195.